Consultar Documento

Este endpoint permite consultar os dados de um documento criado para assinatura eletrônica.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Requisição

GET https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/{id} JWT scope: doc-signature/read:documents

Parâmetros

Nome	Tipo	Descrição
id	string	Identificador único do documento, no formato UUID.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Accept	application/json

Respostas

Código	Descrição
200	Retorna os dados do documento criado para assinatura eletrônica.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Accept", "application/json");

const requestOptions = {
  method: "GET",
  headers: headers,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/c58a0dc6-f862-40eb-92cd-20922d1d618a",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/c58a0dc6-f862-40eb-92cd-20922d1d618a' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Exemplo de Resposta

info

Os campos originalFile e signedFile são URLs temporárias, válidas por 60 minutos. Para baixar o arquivo, utilize o método GET.

{
  "data": {
    "type": "documents",
    "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
    "attributes": {
      "status": "pending",
      "businessId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
      "signers": [
        {
          "businessId": "XPTO-CLIENTE-12345-001",
          "name": "Fulano de Tal",
          "email": "fulano@example.com"
        }
      ],
      "originalFile": "https://s3...",
      "signedFile": "https://s3..."
    }
  },
  "links": {
    "self": "https://api-sandbox.catalisa.com.br/doc-signature/api/v1/documents/c58a0dc6-f862-40eb-92cd-20922d1d618a"
  }
}